-
-
Notifications
You must be signed in to change notification settings - Fork 5.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
release-candidate-checklist make target #7588
Conversation
Is there a nudge emoji? |
I kind of like this, but perhaps we should call it |
Well, the cat's out of the bag now... |
👍 |
Another item for the list (from #2539 (comment)): replace github's automatic tarball, which won't work because it's missing the submodules, with one we create from |
The checklist now includes a build of the documentation. Ref #2501 |
The checklist now builds, makes tarballs, builds docs, runs tests and doctests, and runs the benchmarks (really just to check that the code is still current). I'm not sure what else can go on the list that can be automated. |
@@ -38,6 +38,26 @@ debug release: | $(DIRS) $(build_datarootdir)/julia/base $(build_datarootdir)/ju | |||
@export private_libdir=$(private_libdir) && \ | |||
$(MAKE) $(QUIET_MAKE) LD_LIBRARY_PATH=$(build_libdir):$(LD_LIBRARY_PATH) JULIA_EXECUTABLE="$(JULIA_EXECUTABLE_$@)" $(build_private_libdir)/sys.$(SHLIB_EXT) | |||
|
|||
release-candidate-checklist: release test source-dist | |||
@#Check documentation | |||
julia doc/NEWS-update.jl #Add missing cross-references to NEWS.md |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since this relies on release
, might as well make it ./julia
instead of julia
.
I'd like to see even more detail in the list of actions at the end. I feel like we might have written this up before, but I'm not sure. Anyway it should include exactly when to commit, push, tag, and send announcement emails, and anything else like that. |
make -C doc latex SPHINXOPTS="-W" #Rebuild Julia PDF docs pedantically | ||
make -C doc doctest #Run Julia doctests | ||
make -C doc linkcheck #Check all links | ||
make -C doc helpdb.jl #Rebuild Julia online documentation for help(), apropos(), etc... |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Seems like you should check that none of these made the git repo dirty.
@JeffBezanson I added a few more items to the list, but by far the step with the most magic is step |
How about we keep the instructions only in |
The lists refer to totally different things IMO --- this one documents our process for putting out a release, and DISTRIBUTING is about making binary distributions from a given version, or possibly even from an unreleased version. |
The Makefile just feels like a strange place to have such a list. |
It would be ok to have this documented elsewhere and just have the make target |
Added a run of DocCheck.jl and rebased. (Note that this now errors out due to the warnings thrown in #7837) |
This attempts to document and automate a checklist for producing a release candidate, to the extent that this is possible.
I'm merging and tagging. |
release-candidate-checklist make target
I'm also seeing another regression: Profile.print is showing c locations whether I ask for them or not. |
I don't think that's related to this PR. This PR only touched stuff in |
I know, I'm just saying it here since it might be blocking. |
Well, I think we might need to hold off on tagging tonight then and reconvene in the morning. |
A speculative list trying to automate the steps needed to produce a release candidate.